/**
 * Copyright (c) 2010 Basil Shikin, BugStat Project
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.bugstat.common;

import java.io.IOException;
import java.util.Date;

import org.bugstat.common.bugs.Bug;

/**
 * This class represents a class that can provide bug definitions to bug generator 
 *
 * @author Basil Shikin
 *
 */
public interface BugProvider
{
    /**
     * Retrieve all bug tracker bugs for a given date. Notify provided receiver of
     * each retrieved bug.
     *  
     * @param date Date to retrieve bugs for. Must not be null.
     * @param receiver Receiver to notify of the bugs. Must not be null.
     * 
     * @throws IOException In case unable to retrieve bugs
     */
    public void retrieveBugs( Date date, BugReceiver receiver ) throws IOException;
    
    /**
     * This interface defines a receiver (a class that will be processing retrieved bugs). It
     * should be used only in <code>retrieveBugs()</code>
     * 
     * @author Basil Shikin
     *
     */
    public interface BugReceiver
    {
        /**
         * Notify receiver of the new bug to process
         * 
         * @param bug Bug to process.
         */
        public void processBug( Bug bug );
    }
}
